Fix broken `create_lerobot_dataset_card` #590

helper2424 · 2024-12-19T17:59:10Z

What this does

During the recording of dataset for HIL-SERL integration I have found the following issue:

Traceback (most recent call last):.93M/4.54M [00:01<00:00, 4.89MB/s]
  File "/Users/helper2424/Documents/lerobot/lerobot/scripts/control_robot.py", line 577, in <module>      | 3/6 [00:03<00:04,  1.38s/it]
    record(robot, **kwargs)███████████| 6/6 [00:03<00:00,  1.88it/s]
  File "/Users/helper2424/Documents/lerobot/lerobot/common/robot_devices/utils.py", line 28, in wrapper
    raise e
  File "/Users/helper2424/Documents/lerobot/lerobot/common/robot_devices/utils.py", line 24, in wrapper
    return func(robot, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/helper2424/Documents/lerobot/lerobot/scripts/control_robot.py", line 334, in record
    dataset.push_to_hub(tags=tags)
  File "/Users/helper2424/Documents/lerobot/lerobot/common/datasets/lerobot_dataset.py", line 499, in push_to_hub
    card = create_lerobot_dataset_card(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/helper2424/Documents/lerobot/lerobot/common/datasets/utils.py", line 500, in create_lerobot_dataset_card
    return DatasetCard.from_template(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/helper2424/Library/Caches/pypoetry/virtualenvs/lerobot-_GqtL9sV-py3.12/lib/python3.12/site-packages/huggingface_hub/repocard.py", line 480, in from_template
    return super().from_template(card_data, template_path, template_str, **template_kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/helper2424/Library/Caches/pypoetry/virtualenvs/lerobot-_GqtL9sV-py3.12/lib/python3.12/site-packages/huggingface_hub/repocard.py", line 329, in from_template
    template_str = Path(template_path).read_text()
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/[email protected]/3.12.7_1/Frameworks/Python.framework/Versions/3.12/lib/python3.12/pathlib.py", line 1027, in read_text
    with self.open(mode='r', encoding=encoding, errors=errors) as f:
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/[email protected]/3.12.7_1/Frameworks/Python.framework/Versions/3.12/lib/python3.12/pathlib.py", line 1013, in open
    return io.open(self, mode, buffering, encoding, errors, newline)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: '<contextlib._GeneratorContextManager object at 0x3181632f0>'

This is issue is relevant in the last main.

Examples:

Title	Label
Fixes #[issue]	(🐛 Bug)

How it was tested

How to test that issue is fixed:

Run data collection script, mine is the following:

python lerobot/scripts/control_robot.py record \
    --robot-path lerobot/configs/robot/koch_helper2424.yaml \
    --num-episodes 2 \
    --warmup-time-s 5 \
    --episode-time-s 10 \
    --fps 30 \
    --assign-rewards 1 \
    --policy-overrides "device=mps" \
    --repo-id ${HF_USER}/hil-serl-pusht-reward-classifier-test \
    --single-task "Push small T object to the correct position"

Run pytest tests/lerobot/common/datasets/test_utils.py

jackvial

Tested on my setup and it worked great. Here's the tests dataset I created https://huggingface.co/datasets/jackvial/create_lerobot_dataset_card_fix_test_0

The fix and unit tests make sense 👍

michel-aractingi · 2024-12-21T11:35:04Z

cc @aliberts for visibility

aliberts · 2024-12-21T18:21:21Z

Thank you @helper2424!

Could you expand on why using

card_template = (importlib.resources.files("lerobot.common.datasets") / "card_template.md").read_text()

DatasetCard.from_template(
    card_data=card_data,
    template_str=card_template,
)

rather than

card_template_path = importlib.resources.path("lerobot.common.datasets", "card_template.md")

DatasetCard.from_template(
    card_data=card_data,
    template_path=str(card_template_path),
)

fixed your issue? Both should be +/- equivalent.
It looked from your stack trace that the file wasn't there. Am I reading this wrong?

helper2424 · 2024-12-22T05:34:48Z

@aliberts Hello, the file exists, the issue with the following - code str(card_template_path) returns '<contextlib._GeneratorContextManager object at 0x3181632f0>'. It return the introspection of the object instead of the path to the file. Also, I see that the contextlib generates a lot of warnings about the API usage, so I decided the way that doesn't generate warnings and that looks ok with their long term development way.

helper2424 · 2024-12-22T05:36:16Z

@aliberts in my PR I read the content of the file and pass it to the from_template.

aliberts · 2024-12-23T11:09:46Z

@helper2424 I can't seem to be able to reproduce you error. Currently, running this on main give me no error:

from lerobot.common.datasets.utils import create_lerobot_dataset_card

card = create_lerobot_dataset_card()
print(card)

And when running it with the debugger and inspecting str(card_template_path), I do get the correct path as a str.

After digging a bit, I think this is probably due to differences between our environments and how lerobot was installed, which could make importlib.resources behave differently. I also noticed that importlib.resources.path should be used as a context manager, which it's not here. Let's make this change then!

aliberts · 2024-12-23T11:17:51Z

Style test is failing, you can fix this by running our pre-commits.
Install pre-commit:

# using pip
pip install -e '.[dev]'

# or using poetry
poetry install --extras 'dev'

Run pre-commits

pre-commit run -a

Then commit & push

aliberts

LGTM, thanks!

* feat: enable to use multiple rgb encoders per camera in diffusion policy (huggingface#484) Co-authored-by: Alexander Soare <[email protected]> * Fix config file (huggingface#495) * fix: broken images and a few minor typos in README (huggingface#499) Signed-off-by: ivelin <[email protected]> * Add support for Windows (huggingface#494) * bug causes error uploading to huggingface, unicode issue on windows. (huggingface#450) * Add distinction between two unallowed cases in name check "eval_" (huggingface#489) * Rename deprecated argument (temporal_ensemble_momentum) (huggingface#490) * Dataset v2.0 (huggingface#461) Co-authored-by: Remi <[email protected]> * Refactor OpenX (huggingface#505) * Fix missing local_files_only in record/replay (huggingface#540) Co-authored-by: Simon Alibert <[email protected]> * Control simulated robot with real leader (huggingface#514) Co-authored-by: Remi <[email protected]> * Update 7_get_started_with_real_robot.md (huggingface#559) * LerobotDataset pushable to HF from any folder (huggingface#563) * Fix example 6 (huggingface#572) * fixing typo from 'teloperation' to 'teleoperation' (huggingface#566) * [vizualizer] for LeRobodDataset V2 (huggingface#576) * Fix broken `create_lerobot_dataset_card` (huggingface#590) * feat(act): support training end of episode token to ACT model * changes * feat(arx): add arx arm (#2) * feat(arx): support arx arm * changes * changes * changes * changes * pass pipes explicitly * changes * us ndarray over a pipe * changes * changes * replay basically works * patch arx sdk * changes * support cameras in arx5 * rename to arx5 * kind of works * changes * changes * changes * various changes * changes * revert a few changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * remove TODO * allow multiple tasks --------- Signed-off-by: ivelin <[email protected]> Co-authored-by: Hirokazu Ishida <[email protected]> Co-authored-by: Alexander Soare <[email protected]> Co-authored-by: Arsen Ohanyan <[email protected]> Co-authored-by: Ivelin Ivanov <[email protected]> Co-authored-by: Daniel Ritchie <[email protected]> Co-authored-by: resolver101757 <[email protected]> Co-authored-by: Jannik Grothusen <[email protected]> Co-authored-by: KasparSLT <[email protected]> Co-authored-by: Simon Alibert <[email protected]> Co-authored-by: Remi <[email protected]> Co-authored-by: Michel Aractingi <[email protected]> Co-authored-by: Simon Alibert <[email protected]> Co-authored-by: berjaoui <[email protected]> Co-authored-by: Claudio Coppola <[email protected]> Co-authored-by: s1lent4gnt <[email protected]> Co-authored-by: Mishig <[email protected]> Co-authored-by: Eugene Mironov <[email protected]>

* feat: enable to use multiple rgb encoders per camera in diffusion policy (huggingface#484) Co-authored-by: Alexander Soare <[email protected]> * Fix config file (huggingface#495) * fix: broken images and a few minor typos in README (huggingface#499) Signed-off-by: ivelin <[email protected]> * Add support for Windows (huggingface#494) * bug causes error uploading to huggingface, unicode issue on windows. (huggingface#450) * Add distinction between two unallowed cases in name check "eval_" (huggingface#489) * Rename deprecated argument (temporal_ensemble_momentum) (huggingface#490) * Dataset v2.0 (huggingface#461) Co-authored-by: Remi <[email protected]> * Refactor OpenX (huggingface#505) * Fix missing local_files_only in record/replay (huggingface#540) Co-authored-by: Simon Alibert <[email protected]> * Control simulated robot with real leader (huggingface#514) Co-authored-by: Remi <[email protected]> * Update 7_get_started_with_real_robot.md (huggingface#559) * LerobotDataset pushable to HF from any folder (huggingface#563) * Fix example 6 (huggingface#572) * fixing typo from 'teloperation' to 'teleoperation' (huggingface#566) * [vizualizer] for LeRobodDataset V2 (huggingface#576) * Fix broken `create_lerobot_dataset_card` (huggingface#590) * Update README.md (huggingface#612) * Fix Quality workflow (huggingface#622) * fix(docs): typos in benchmark readme.md (huggingface#614) Co-authored-by: Simon Alibert <[email protected]> * fix(visualise): use correct language description for each episode id (huggingface#604) Co-authored-by: Simon Alibert <[email protected]> * typo fix: batch_convert_dataset_v1_to_v2.py (huggingface#615) Co-authored-by: Simon Alibert <[email protected]> * [viz] Fixes & updates to html visualizer (huggingface#617) * fixes to SO-100 readme (huggingface#600) Co-authored-by: Philip Fung <no@one> Co-authored-by: Simon Alibert <[email protected]> --------- Signed-off-by: ivelin <[email protected]> Co-authored-by: Hirokazu Ishida <[email protected]> Co-authored-by: Alexander Soare <[email protected]> Co-authored-by: Arsen Ohanyan <[email protected]> Co-authored-by: Ivelin Ivanov <[email protected]> Co-authored-by: Daniel Ritchie <[email protected]> Co-authored-by: resolver101757 <[email protected]> Co-authored-by: Jannik Grothusen <[email protected]> Co-authored-by: KasparSLT <[email protected]> Co-authored-by: Simon Alibert <[email protected]> Co-authored-by: Remi <[email protected]> Co-authored-by: Michel Aractingi <[email protected]> Co-authored-by: Simon Alibert <[email protected]> Co-authored-by: berjaoui <[email protected]> Co-authored-by: Claudio Coppola <[email protected]> Co-authored-by: s1lent4gnt <[email protected]> Co-authored-by: Mishig <[email protected]> Co-authored-by: Eugene Mironov <[email protected]> Co-authored-by: CharlesCNorton <[email protected]> Co-authored-by: Philip Fung <[email protected]> Co-authored-by: Philip Fung <no@one>

[Fix] Move back to manual calibration (#488) feat: enable to use multiple rgb encoders per camera in diffusion policy (#484) Co-authored-by: Alexander Soare <[email protected]> Fix config file (#495) fix: broken images and a few minor typos in README (#499) Signed-off-by: ivelin <[email protected]> Add support for Windows (#494) bug causes error uploading to huggingface, unicode issue on windows. (#450) Add distinction between two unallowed cases in name check "eval_" (#489) WIP Fix autocalib moss (#486) [Fix] Move back to manual calibration (#488) feat: enable to use multiple rgb encoders per camera in diffusion policy (#484) Co-authored-by: Alexander Soare <[email protected]> Fix config file (#495) fix: broken images and a few minor typos in README (#499) Signed-off-by: ivelin <[email protected]> Add support for Windows (#494) bug causes error uploading to huggingface, unicode issue on windows. (#450) Add distinction between two unallowed cases in name check "eval_" (#489) Rename deprecated argument (temporal_ensemble_momentum) (#490) Dataset v2.0 (#461) Co-authored-by: Remi <[email protected]> Refactor OpenX (#505) Fix missing local_files_only in record/replay (#540) Co-authored-by: Simon Alibert <[email protected]> Control simulated robot with real leader (#514) Co-authored-by: Remi <[email protected]> Update 7_get_started_with_real_robot.md (#559) LerobotDataset pushable to HF from any folder (#563) Fix example 6 (#572) fixing typo from 'teloperation' to 'teleoperation' (#566) [vizualizer] for LeRobodDataset V2 (#576) Fix broken `create_lerobot_dataset_card` (#590) Update README.md (#612) Add draccus, create MainConfig WIP refactor train.py and ACT Add policies training presets Update diffusion policy Add pusht and xarm env configs Update tdmpc Update vqbet Fix poetry relax Add feature types to envs Add EvalPipelineConfig, parse features from envs Add custom parser Update pretrained loading mechanisms Add dependency fixes & lock update Fix pretrained_path Refactor envs, remove RealEnv Fix typo Enable end-to-end tests Fix Makefile Log eval config Fix end-to-end tests Fix Quality workflow (#622) Remove amp & add resume test Speed-up tests Fix poetry relax Remove config yaml for robot devices (#594) Co-authored-by: Simon Alibert <[email protected]> fix(docs): typos in benchmark readme.md (#614) Co-authored-by: Simon Alibert <[email protected]> fix(visualise): use correct language description for each episode id (#604) Co-authored-by: Simon Alibert <[email protected]> typo fix: batch_convert_dataset_v1_to_v2.py (#615) Co-authored-by: Simon Alibert <[email protected]> [viz] Fixes & updates to html visualizer (#617) Fix logger Remove hydra-core Add aggregate_stats Add estimate_num_samples for images, Add test image Remove NoneSchedulerConfig Add push_pretrained Remove eval.episode_length Fix wandb_video Fix typo Add features back into policy configs (#643) fixes to SO-100 readme (#600) Co-authored-by: Philip Fung <no@one> Co-authored-by: Simon Alibert <[email protected]> Fix for the issue #638 (#639) Fix env_to_policy_features call Fix wandb init remove omegaconf Add branch arg Move deprecated Move training config Remove pathable_args Implement custom HubMixin Fixes Implement PreTrainedPolicy base class Add HubMixin to TrainPipelineConfig Udpate example 2 & 3 Update push_pretrained Bump`rerun-sdk` dependency to `0.21.0` (#618) Co-authored-by: Simon Alibert <[email protected]> Fix config_class Fix from_pretrained kwargs Remove policy_protocol Camelize PretrainedConfig Additional fix while retraining policies (#629) Co-authored-by: Simon Alibert <[email protected]> Actually reactivate tdmpc online test Update example 4 Remove advanced example 1 Remove example 5 Move example 6 to advanced Use HubMixin.save_pretrained Enable config_path to be a repo_id Dry has_method Update example 4 Update README Cleanup pyproject.toml Update eval docstring Update README Clean example 4 Update README Make 'last' checkpoint symlink relative Fix cluster image (#653) Simplify example 4 fix stats per episodes and aggregate stats and casting to tensor

helper2424 added 2 commits December 20, 2024 00:41

Fix broken create_lerobot_dataset_card after migration to the dataset 2

841aae1

Add tests for fixed method

e0f3453

helper2424 mentioned this pull request Dec 19, 2024

Use importlib.resources.files for card template path access #589

Closed

jackvial approved these changes Dec 20, 2024

View reviewed changes

Fix linter

ce6a59f

aliberts approved these changes Dec 23, 2024

View reviewed changes

aliberts merged commit 59e2757 into huggingface:main Dec 23, 2024
5 checks passed

chrisheninger pushed a commit to chrisheninger/lerobot that referenced this pull request Jan 26, 2025

Fix broken create_lerobot_dataset_card (huggingface#590)

0c6aa01

michel-aractingi pushed a commit that referenced this pull request Feb 3, 2025

Fix broken create_lerobot_dataset_card (#590)

4a43c83

menhguin pushed a commit to menhguin/lerobot that referenced this pull request Feb 9, 2025

Fix broken create_lerobot_dataset_card (huggingface#590)

ff87ba6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix broken `create_lerobot_dataset_card` #590

Fix broken `create_lerobot_dataset_card` #590

helper2424 commented Dec 19, 2024

jackvial left a comment

michel-aractingi commented Dec 21, 2024

aliberts commented Dec 21, 2024

helper2424 commented Dec 22, 2024 •

edited

Loading

helper2424 commented Dec 22, 2024

aliberts commented Dec 23, 2024

aliberts commented Dec 23, 2024

aliberts left a comment

Fix broken create_lerobot_dataset_card #590

Fix broken create_lerobot_dataset_card #590

Conversation

helper2424 commented Dec 19, 2024

What this does

How it was tested

jackvial left a comment

Choose a reason for hiding this comment

michel-aractingi commented Dec 21, 2024

aliberts commented Dec 21, 2024

helper2424 commented Dec 22, 2024 • edited Loading

helper2424 commented Dec 22, 2024

aliberts commented Dec 23, 2024

aliberts commented Dec 23, 2024

aliberts left a comment

Choose a reason for hiding this comment

Fix broken `create_lerobot_dataset_card` #590

Fix broken `create_lerobot_dataset_card` #590

helper2424 commented Dec 22, 2024 •

edited

Loading